Skip to content

adk docs update audit#461

Open
adkah wants to merge 30 commits intoaj/adk-docs-updatefrom
ak-aj-adk-docs-update
Open

adk docs update audit#461
adkah wants to merge 30 commits intoaj/adk-docs-updatefrom
ak-aj-adk-docs-update

Conversation

@adkah
Copy link
Copy Markdown
Collaborator

@adkah adkah commented Apr 22, 2026

No description provided.

Comment thread adk/quickstart.mdx
jacksonyzj added a commit that referenced this pull request Apr 23, 2026
Incorporates PR #461 (adrian-kahali):
- Get Started restructure: welcome -> introduction, new top-level
  quickstart, updated docs.json sidebar
- Configuration page: <Tip> blocks linking to related guides,
  expandable config snippet, cleaner prose
- Environment setup: consolidated secrets + config explanations,
  better wording
- Integrations: clearer intro, CLI section labelled
- Conversations: <CodeGroup> for channel matching, <Tip> blocks
  for cross-references
- AI execution: <Note> for LLMz reference, tighter phrasing
- Tools: highlight annotations on code blocks

Conflicts resolved in favor of keeping the audit fixes from this
branch (correct default model order, ms units for idleTimeout,
evals/ path, agent-steps screenshot, no trailing Cards, no
standalone Dev console sections, "Botpress Cloud" wording, real
CLI reference secrets table instead of placeholder link) while
taking Adrian's <Tip>/<Note> block styling and structural
improvements.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@adkah adkah marked this pull request as ready for review April 24, 2026 17:58
@adkah adkah requested a review from jacksonyzj April 24, 2026 18:09
@adkah adkah self-assigned this Apr 24, 2026
@adkah adkah requested a review from aj-botpress April 24, 2026 18:09
@adkah adkah removed their assignment Apr 24, 2026
- configuration: move evals/ out of src/ in the project tree (evals
  live at the agent root, not under src/)
- environment: remove duplicate standalone Dev console subsection
  under Configuration (image is already inlined above)
- tools: drop src/tools/ from the lead-in since tools can live
  anywhere under src/
- tables: fix "Must with a letter" typo -> "Must start with a letter"
- evals: Eval import back to @botpress/runtime (it's exported from
  runtime/library.ts, not @botpress/adk; matches packages/lack/evals/*)
- workflows: rename hyphenated workflow names to camelCase across
  create/steps/request-notify/evals/actions/knowledge/extract examples
  (generator emits unquoted keys in .adk/workflow-types.d.ts, so
  hyphenated names produce invalid TypeScript)
- tables: drop `createdAt` from the OrderTable example (it's a
  reserved column per runtime/primitives/table.ts:320)
- integrations: reconcile the Enable/Disable section so it no longer
  contradicts the CLI section about newly-added integrations being
  disabled by default
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants